Add Subscriber Email
The Add Subscriber Email request lets you add a subscriber email address.
URI
{{baseUrl}}/api/v2/customer/{customerGuid}/user/{subscriberEmail}/script
HTTP Method
POST
Request (Query) Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
customerGuid * string($uuid) |
path |
Customer subscriber Azure Tenant Guid. |
|
subscriberEmail * string |
path |
Customer subscriber Email address. |
|
X-Ovoc-Channel-Id |
integer |
The Live Platform channel "id". When specified, data retrieval is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. You can alternatively use "X-IAM-Account-Id" which as result generates an identical response. |
|
X-IAM-Account-Id |
string |
The Live Platform "iamAccountId" of the channel. When specified, data retrieval is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value. |
Response
| ■ | 200 Success |
| ■ | 400 Bad Request |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk", |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 409 Conflict |
|
Parameter |
Type |
Description/Examples |
|---|---|---|
|
errors |
string |
Text description of the error. |
|
type |
string |
"https://tools.ietf.org/html/rfc7231#section-6.5.1" |
|
title |
string |
Email title. For example "One or more validation errors occurred." |
|
status |
error code |
HTML error code i.e. 400 |
|
detail |
string |
Additional error details. |
|
traceId |
string |
Error trace Id |
|
instance |
string |
Error instance |
|
errorTicket |
string |
This field may not appear for all return codes. |
|
errorCode |
string |
This field may not appear for all return codes. |
|
additionalProp1 |
string |
Custom Script variable argument. For example "CacProfile": "5 sessions" |
|
additionalProp2 |
string |
Custom Script argument. For example, ProxySet": "SIPTrunk", |
|
additionalProp3 |
string |
Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be" |
| ■ | 403 Forbidden: this error is raised when an attempt is made to delete a SIP connection that belongs to a customer that is not attached to the channel as specified by X-Ovoc-Channel-Id or X-IAM-Account-Id values as Query parameters. |
| ■ | 422 Unsupported tenant type: this error is raised in the event where the service has not yet been upgraded to Essentials Plus or Pro licenses. |
| ■ | 500 Server Error |